package com.plug.common.consts;

/**
 * 接口返回Code定义
 * <p/>
 * 此处定义的错误代码将用于开放API接口返回和普通的RESTful接口返回<p/>
 * 返回代码定义规则：<p/>
 * 全局代码：
 * <ul>
 * <li>操作成功: 0</li>
 * <li>操作失败: -1</li>
 * <li>成功响应: 200</li>
 * <li>无效参数: 40000</li>
 * <li>发生异常: 50000</li>
 * </ul>
 * 自定义代码：<p/>
 * 例：400100 - 400199 自定菜单参数错误 400200 - 400299 消息回复参数错误<br/>
 * 例：500100 - 500199 自定义菜单操作异常 ...
 *
 * @author Archx[archx@foxmail.com]
 * @date 2016/3/17 0017
 */
public interface Code {

    /**
     * 成功
     * <p/>
     * HTTP 状态码 200
     */
    int SUCCESS = 0;

    /**
     * 成功响应
     * <p/>
     * 等同于HTTP 状态码 200
     */
    int OK = 200;

    /**
     * 处理失败
     * <p/>
     * HTTP 状态码 200
     */
    int FAILED = -1;

    /**
     * 无效的参数
     */
    int ERR_INVALID_PARAMETER = 40000;
    // 自定义菜单的名称无效
    // ERR_INVALID_CUSTOM_MENU_NAME = 400101

    /**
     * 发生异常
     */
    int ERR_EXCEPTION_OCCURS = 50000;
    // 自定义菜单添加异常
    // ERR_EXCEPTION_CUSTOM_MENU_ADD = 500101
}
